Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: document new backup/restore procedure and webapps specific config #4791

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

entangled90
Copy link
Contributor

@entangled90 entangled90 commented Dec 18, 2024

Description

This PR updates the documentation related to performing backups and restoring them for self managed as a result EPIC camunda/camunda#24456.

Backups for webapps can now be performed by any webapps (operate, tasklist or optimize) and there is no need anymore to perform one for each app.

The order of the operations has also changed (source: decision document):
1 - Soft Pause on Zeebe to export - POST actuator/exporting/pause?soft=true
2 - SaaS Controller triggers WebApps and monitor it together
3 - Backup Zeebe ES Records
4 - Backup Zeebe Data
5 - Resume exporting

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@entangled90 entangled90 added component:zeebe Issues related with Zeebe project component:operate Issues related with Operate project component:tasklist Issues related with Tasklist project component:optimize Issues related with Optimize project labels Dec 18, 2024
@entangled90 entangled90 self-assigned this Dec 18, 2024
Copy link
Contributor

github-actions bot commented Dec 18, 2024

👋 🤖 🤔 Hello, @entangled90! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/self-managed/operational-guides/backup-restore/backup-and-restore.md
  • docs/self-managed/operational-guides/backup-restore/optimize-backup.md
  • docs/self-managed/operational-guides/backup-restore/webapps-backup.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@entangled90 entangled90 force-pushed the cs-4790-new-backup-restore-procedure branch from b18d8db to 4bd252d Compare December 19, 2024 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:operate Issues related with Operate project component:optimize Issues related with Optimize project component:tasklist Issues related with Tasklist project component:zeebe Issues related with Zeebe project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant